Headings
  • 23 Sep 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Headings

  • Dark
    Light

Article summary

Headings are used in technical documentation to organize and structure the content, making it easier for readers to find and understand the information they need. They also help to break up long blocks of text and make the document more visually appealing.

There are several types of headings that may be used in technical documentation, including:

Main headings
These are the highest-level headings in the document and are usually used to indicate the major sections or topics covered. They should be used sparingly and should be clearly distinguished from other headings.

Subheadings
These are used to further divide and organize the content within the main sections of the document. They should be used to introduce new ideas or topics and should be clearly related to the main heading.

Sub-subheadings
These are used to divide the content even further and provide additional detail on specific ideas or topics. They should be used sparingly and should be clearly related to the subheading under which they appear.

Lists
Lists are often used in technical documentation to present information in a clear and concise manner. They can be used at any level of the document hierarchy and can be used to highlight key points or to present a series of steps or procedures.

Rules

  • Use sentence case for headings
  • Use heading tags
  • Do not use period for headings
  • Use question mark and exclamation point if required
Document360 style
  • Configuration of custom domain
  • How to update a team account?
Not Document360 style
  • Create a new category.
  • Add A New Team Account

Was this article helpful?

What's Next
ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence